Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

eslint: Enable @wordpress/no-unused-vars-before-return rule #39127

Merged
merged 4 commits into from
Sep 6, 2024
Merged

eslint: Enable @wordpress/no-unused-vars-before-return rule #39127

merged 4 commits into from
Sep 6, 2024

Conversation

anomiex
Copy link
Contributor

@anomiex anomiex commented Aug 28, 2024

Proposed changes:

This rule tries to find cases where a variable is set to the result of a function call, but then an early return happens before that value is used. The idea being that we can likely save work by not calling a bunch of functions unnecessarily.

Watch out for functions that have side effects, though. It may be that those need to be called even if the return value doesn't seem to be used. React hooks particularly fall into this category; when our jetpack-js-tools/eslintrc/react config is extended any functions beginning with "use" are ignored as such, but sometimes it seems we're forgetting to extend that.

Other information:

  • Have you written new tests for your changes, if applicable?
  • Have you checked the E2E test CI results, and verified that your changes do not break them?
  • Have you tested your changes on WordPress.com, if applicable (if so, you'll see a generated comment below with a script to run)?

Jetpack product discussion

Followup to #38436

Does this pull request change what data or activity we track or use?

No

Testing instructions:

  • Everything should still work as it did before.

@anomiex
eslint: Enable @wordpress/no-unused-vars-before-return rule
b7534ea 
This rule tries to find cases where a variable is set to the result of a
function call, but then an early return happens before that value is
used. The idea being that we can likely save work by not calling a bunch
of functions unnecessarily.

Watch out for functions that have side effects, though. It may be that
those need to be called even if the return value doesn't seem to be
used. React hooks particularly fall into this category; when our
`jetpack-js-tools/eslintrc/react` config is extended any functions
beginning with "use" are ignored as such, but sometimes it seems we're
forgetting to extend that.
@anomiex anomiex added [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. [Type] Janitorial [Pri] Normal labels Aug 28, 2024
@anomiex anomiex requested a review from a team August 28, 2024 19:26
@anomiex anomiex self-assigned this Aug 28, 2024
@anomiex anomiex enabled auto-merge (squash) August 28, 2024 19:26
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Aug 28, 2024 •
edited
Loading

Are you an Automattician? Please test your changes on all WordPress.com environments to help mitigate accidental explosions.

  • To test on WoA, go to the Plugins menu on a WordPress.com Simple site. Click on the "Upload" button and follow the upgrade flow to be able to upload, install, and activate the Jetpack Beta plugin. Once the plugin is active, go to Jetpack > Jetpack Beta, select your plugin, and enable the add/enable-eslint-wordpress-no-unused-vars-before-return branch.

    • For jetpack-mu-wpcom changes, also add define( 'JETPACK_MU_WPCOM_LOAD_VIA_BETA_PLUGIN', true ); to your wp-config.php file.

  • To test on Simple, run the following command on your sandbox:

    bin/jetpack-downloader test jetpack add/enable-eslint-wordpress-no-unused-vars-before-return

    bin/jetpack-downloader test jetpack-mu-wpcom-plugin add/enable-eslint-wordpress-no-unused-vars-before-return

Interested in more tips and information?

  • In your local development environment, use the jetpack rsync command to sync your changes to a WoA dev blog.
  • Read more about our development workflow here: PCYsg-eg0-p2
  • Figure out when your changes will be shipped to customers here: PCYsg-eg5-p2

@github-actions github-actions bot added [Package] Backup [Package] Classic Theme Helper [Package] Forms [Package] Jetpack mu wpcom WordPress.com Features [Package] Masterbar [Package] My Jetpack [Package] Publicize [Package] Search Contains core Search functionality for Jetpack and Search plugins [Package] VideoPress [Plugin] Beta For serving live branches and the beta versions. https://github.com/automattic/jetpack-beta [Plugin] CRM Issues about the Jetpack CRM plugin [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ [Plugin] Protect A plugin with features to protect a site: brute force protection, security scanning, and a WAF. Admin Page React-powered dashboard under the Jetpack menu RNA labels Aug 28, 2024
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Aug 28, 2024 •
edited
Loading

Thank you for your PR!

When contributing to Jetpack, we have a few suggestions that can help us test and review your patch:

  • ✅ Include a description of your PR changes.
  • ✅ Add a "[Status]" label (In Progress, Needs Team Review, ...).
  • ✅ Add testing instructions.
  • ✅ Specify whether this PR includes any changes to data or privacy.
  • ✅ Add changelog entries to affected projects

This comment will be updated as you work on your PR and make changes. If you think that some of those checks are not needed for your PR, please explain why you think so. Thanks for cooperation 🤖

The e2e test report can be found here. Please note that it can take a few minutes after the e2e tests checks are complete for the report to be available.

Follow this PR Review Process:

  1. Ensure all required checks appearing at the bottom of this PR are passing.
  2. Choose a review path based on your changes:
    • A. Team Review: add the "[Status] Needs Team Review" label
      • For most changes, including minor cross-team impacts.
      • Example: Updating a team-specific component or a small change to a shared library.
    • B. Crew Review: add the "[Status] Needs Review" label
      • For significant changes to core functionality.
      • Example: Major updates to a shared library or complex features.
    • C. Both: Start with Team, then request Crew
      • For complex changes or when you need extra confidence.
      • Example: Refactor affecting multiple systems.
  3. Get at least one approval before merging.

Still unsure? Reach out in #jetpack-developers for guidance!

Beta plugin:

  • Next scheduled release: none scheduled.

If you have any questions about the release process, please ask in the #jetpack-releases channel on Slack.

Jetpack plugin:

The Jetpack plugin has different release cadences depending on the platform:

  • WordPress.com Simple releases happen daily.
  • WoA releases happen weekly.
  • Releases to self-hosted sites happen monthly. The next release is scheduled for September 10, 2024 (scheduled code freeze on undefined).

If you have any questions about the release process, please ask in the #jetpack-releases channel on Slack.

Protect plugin:

  • Next scheduled release: none scheduled.

If you have any questions about the release process, please ask in the #jetpack-releases channel on Slack.

zinigor
zinigor previously approved these changes Sep 6, 2024
View reviewed changes
Copy link
Member

@zinigor zinigor left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wow, what a useful rule!

@anomiex anomiex merged commit 933e2a9 into trunk Sep 6, 2024
73 checks passed
@anomiex anomiex deleted the add/enable-eslint-wordpress-no-unused-vars-before-return branch September 6, 2024 19:25
@github-actions github-actions bot removed the [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. label Sep 6, 2024
gogdzl pushed a commit that referenced this pull request Oct 25, 2024
@anomiex @gogdzl
eslint: Enable @wordpress/no-unused-vars-before-return rule (#39127)
9e27887 
This rule tries to find cases where a variable is set to the result of a
function call, but then an early return happens before that value is
used. The idea being that we can likely save work by not calling a bunch
of functions unnecessarily.

Watch out for functions that have side effects, though. It may be that
those need to be called even if the return value doesn't seem to be
used. React hooks particularly fall into this category; when our
`jetpack-js-tools/eslintrc/react` config is extended any functions
beginning with "use" are ignored as such, but sometimes it seems we're
forgetting to extend that.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@zinigor zinigor zinigor left review comments

Assignees

@anomiex anomiex

Labels
Admin Page React-powered dashboard under the Jetpack menu [Block] AI Assistant [Block] Contact Form Form block (also see Contact Form label) [Block] Donations [Block] Eventbrite [Block] Google Docs Embed [Block] Mailchimp [Block] Map [Block] Pay With Paypal aka Simple Payments [Block] Podcast Player [Block] Send a message [Block] Story [Block] Tiled Gallery [Block] VideoPress [Extension] AI Assistant Plugin [Extension] Payments [Extension] SEO [Feature] Contact Form [Feature] Masterbar WordPress.com Toolbar and Dashboard customizations [Feature] Theme Tools [JS Package] AI Client [JS Package] I18n Check Webpack Plugin [mu wpcom Feature] Wpcom Block Editor Nux [Package] Backup [Package] Classic Theme Helper [Package] Forms [Package] Jetpack mu wpcom WordPress.com Features [Package] Masterbar [Package] My Jetpack [Package] Publicize [Package] Search Contains core Search functionality for Jetpack and Search plugins [Package] VideoPress [Plugin] Beta For serving live branches and the beta versions. https://github.com/automattic/jetpack-beta [Plugin] CRM Issues about the Jetpack CRM plugin [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ [Plugin] Protect A plugin with features to protect a site: brute force protection, security scanning, and a WAF. [Pri] Normal RNA [Type] Janitorial
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@anomiex @zinigor